Credit Control Configuration Mode Commands

Credit Control Configuration Mode Commands
 
The Credit Control Configuration Mode is used to configure prepaid services for Diameter/RADIUS applications.
apn-name-to-be-included
This command configures whether the virtual or real Access Point Name (APN) is sent in Credit Control Application (CCA) messaging.
Product
All
Privilege
Security Administrator, Administrator
Syntax
apn-name-to-be-included { gn | virtual }
default apn-name-to-be-included
default
Configures this command with the default setting.
Default: gn
gn
Sends the Gn APN name in the CCA messages.
virtual
Sends the virtual APN name, if configured in the APN Configuration Mode, in the CCA messages.
Usage
Use this command to configure the APN information in CCA messages. Virtual APN name can be set to be sent in CCA messages if it is configured in the APN Configuration Mode.
Example
The following command sets the virtual APN name to be sent in CCA message:
apn-name-to-be-included virtual
app-level-retransmission
This command enables/disables application-level retransmissions with the “T” bit set.
Product
All
Privilege
Security Administrator, Administrator
Syntax
app-level-retransmission { set-retransmission-bit | unset-retransmission-bit }
default app-level-retransmission
default
Configures this command with the default setting.
Default: unset-retransmission-bit
set-retransmission-bit
Sets the retransmission bit.
unset-retransmission-bit
Unsets the retransmission bit.
Usage
Use this command to enable application-level transmission with “T” bit set.
'T' bit setting is done only for DIABASE protocol-based rerouting and not for application-based retransmissions. In order to identify such retransmissions, the server expects the T bit to be set at all levels (both DIABASE and application) of retransmission, which can be achieved with this CLI command.
Example
The following command specifies to set retransmission bit:
app-level-retransmission set-retransmission-bit
diameter dictionary
This command configures the Diameter Credit Control dictionary for the Active Charging Service (ACS).
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter dictionary { dcca-custom1 | dcca-custom10 | dcca-custom11 | dcca-custom12 | dcca-custom13 | dcca-custom14 | dcca-custom15 | dcca-custom16 | dcca-custom17 | dcca-custom18 | dcca-custom19 | dcca-custom2 | dcca-custom20 | dcca-custom21 | dcca-custom22 | dcca-custom23 | dcca-custom24 | dcca-custom25 | dcca-custom26 | dcca-custom27 | dcca-custom28 | dcca-custom29 | dcca-custom3 | dcca-custom30 | dcca-custom4 | dcca-custom5 | dcca-custom6 | dcca-custom7 | dcca-custom8 | dcca-custom9 | standard }
default diameter dictionary
default
Configures this command with the default setting.
Default: standard dictionary
dcca-custom1 ... dcca-custom30
Specifies a custom Diameter dictionary.
standard
Specifies the standard Diameter dictionary.
Default: Enabled
Usage
Use this command to select the Diameter dictionary for ACS.
Example
The following command selects the standard Diameter dictionary:
diameter dictionary standard
diameter dynamic-rules request-quota
This command specifies to request quota immediately in the CCR sent to the Gy interface when the traffic matches the dynamic rules with Online AVP enabled and received over Gx interface.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter dynamic-rules request-quota { on-traffic-match | on-receiving-rule }
default diameter dynamic-rules request-quota
default
Configures this command with the default setting.
Default: on-receiving-rule
on-traffic-match
Requests quota only when there is traffic matching the dynamic rules with Online AVP enabled.
on-receiving-rule
Requests quota on receiving a dynamic rule with Online AVP enabled.
Usage
Use this command to request quota when the traffic matches the dynamic rules with Online AVP enabled.
Example
The following command specifies to request quota on receiving a dynamic rule with Online AVP enabled:
diameter dynamic-rules request-quota on-receiving-rule
diameter fui-redirected-flow
This command enables to control the behavior of marking redirected HTTP flow as free-of-charge.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no ] diameter fui-redirected-flow allow
no
Disables the behavior of marking redirected HTTP flow as free-of-charge.
Default: diameter fui-redirected-flow allow
Usage
Use this command to control the behavior of marking redirected HTTP flow as free-of-charge when the Final-Unit-Indication (FUI) Diameter AVP comes without Filter IDs.
note_smallImportant: Note that the default value, when configured, does not appear in the output of the show configuration command output; instead appear only in the output of the show configuration verbose command. When the HTTP redirection feature is disabled using the no diameter fui-redirected-flow allow command, it will be appear in the output of the show configuration command.
Example
The following command specifies to allow the packets free of charge, when matching the redirected-flow:
diameter fui-redirected-flow allow
diameter gsu-with-only-infinite-quota
This command configures whether to accept/reject CCA messages that contain Granted-Service-Unit AVP with only infinite quota grants from the server.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter gsu-with-only-infinite-quota { accept-credit-control-answer | reject-credit-control-answer }
default diameter gsu-with-only-infinite-quota
default
Configures this command with the default setting.
Default: reject-credit-control-answer
accept-credit-control-answer
Accepts the Credit-Control-Answer message.
reject-credit-control-answer
Rejects the Credit-Control-Answer message.
Usage
Use this command to accept/reject CCA messages that contain the Granted-Service-Unit AVP with only infinite quota grants from the server.
Example
The following command specifies to accept CCA with the Granted-Service-Unit AVP containing only Infinite quota:
diameter gsu-with-only-infinite-quota accept-credit-control-answer
diameter ignore-returned-rulebase-id
This command configures to accept/ignore the rulebase ID in the Rulebase-Id AVP returned by the Diameter server in CCA messages.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] diameter ignore-returned-rulebase-id
default
Configures this command with the default setting.
Default: Accept
no
Accepts the rulebase ID received from Diameter server in CCA.
Usage
Use this command to ignore/accept rulebase ID returned from the Diameter server in CCA.
Example
The following command ignores the rulebase ID returned from the Diameter server in CCA:
diameter ignore-returned-rulebase-id
diameter ignore-service-id
This command enables to accept/ignore service ID in the Service-Identifier AVP defined in the Diameter dictionaries. This command is applicable to all products that use the Gy interface.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] diameter ignore-service-id
default
Configures this command with the default setting.
Default: Accept
no
Specifies to accepts the service ID.
Usage
Use this command to ignore/accept service ID value in the Service-Identifier AVP in the Diameter dictionaries for Gy interface implementations.
This command can be used to disable the usage of the Service-Identifier AVP for Gy interface implementations even if any of the Diameter dictionaries support the Service-Identifier AVP, and if this AVP should not be used for Gy interactions but must be present in GCDRs/eGCDRs.
Example
The following command specifies to ignore service ID in the Diameter dictionaries:
diameter ignore-service-id
diameter mscc-final-unit-action terminate
This command enables either to terminate a PDP session immediately when the Final-Unit-Action (FUA) in a particular Multiple Service Credit Control (MSCC) is set as TERMINATE and the quota is exhausted for that service, or to terminate the session after all other MSCCs (categories) have used up their available quota.
note_smallImportant: This command is available only in 10.2 and later releases.
Product
GGSN
Privilege
Security Administrator, Administrator
Syntax
diameter mscc-final-unit-action terminate { category | session { on-per-mscc-exhaustion | on-all-mscc-exhaustion } }
default diameter mscc-final-unit-action terminate
default
Configures this command with the default setting.
Default: Same as diameter mscc-final-unit-action terminate category
category
This is the standard behavior wherein the category is terminated if the Final-Unit-Indication AVP comes with TERMINATE for a given MSCC.
session { on-per-mscc-exhaustion | on-all-mscc-exhaustion }
Terminates the session depending on the quota usage of one MSCC or all the MSCCs.
on-per-mscc-exhaustion: When the FUA in a particular MSCC is set as TERMINATE and the quota is exhausted for that service, the session will be terminated immediately regardless of the state of the other MSCCs.
on-all-mscc-exhaustion: When the FUA in a particular MSCC is set as TERMINATE and the quota is exhausted for that service, the session termination will be initiated after all the other MSCCs (categories) have used up their available quota. There will no more CCR(U) messages sent requesting quota after receiving the FUA as TERMINATE in the MSCC level.
Usage
Use this command to terminate a PDP session immediately when the FUA in a particular MSCC is set as TERMINATE and the quota is exhausted for that service, or to terminate the session after all other MSCCs (categories) have used up their available quota.
Example
The following command terminates the PDP session after quota exhausts for all MSCCs when MSCC FUA is set to TERMINATE:
diameter mscc-final-unit-action terminate session on-all-mscc-exhaustion
diameter mscc-per-ccr-update
This command configures sending single/multiple Multiple-Services-Credit-Control (MSCC) AVP in CCR-U messages.
note_smallImportant: This command is available only in 8.3 and later releases.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter mscc-per-ccr-update { multiple | single }
default diameter mscc-per-ccr-update
default
Configures this command with the default setting.
Default: multiple
multiple
Sends multiple Multiple-Services-Credit-Control AVP in a single CCR-U message.
single
Sends only one Multiple-Services-Credit-Control AVP in a CCR-U message.
Usage
Use this command to configure sending single/multiple Multiple-Services-Credit-Control AVP in CCR-U messages.
Example
The following command configures sending a single Multiple-Services-Credit-Control AVP in CCR-U messages:
diameter mscc-per-ccr-update single
diameter origin host
This command is obsolete. See the diameter origin endpoint command.
diameter origin endpoint
This command configures the Diameter Credit Control Origin Endpoint.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter origin endpoint endpoint_name [ realm realm_name ]
no diameter origin endpoint
no
Removes the Diameter Credit Control Origin Endpoint configuration.
endpoint endpoint_name
Specifies the Diameter Credit Control Origin Endpoint name as an alphanumeric string of 1 through 63 characters.
realm realm_name
Specifies the Diameter Credit Control Realm ID as an alphanumeric string of 1 through 127 characters.
Usage
Use this command to configure the Diameter Credit Control Origin Endpoint.
The endpoint to configure should be pre-configured. For information on creating and configuring a Diameter endpoint, see the diameter endpoint command in the Context Configuration mode.
Example
The following command configures a Diameter Credit Control Origin Endpoint named test:
diameter origin endpoint test
diameter peer-select
This command configures the Diameter credit control primary and secondary hosts for DCCA.
Product
All
Privilege
Security Administrator, Administrator
Syntax
In 8.x and earlier releases:
diameter peer-select peer peer_name [ realm realm_name ] [ secondary-peer secondary_peer_name [ realm realm_name ] ] [ imsi-based start-value imsi_start_value end-value imsi_end_value ]
no diameter peer-select [ imsi-based start-value imsi_start_value end-value imsi_end_value ]
In 9.0 and later releases, for UMTS deployments:
diameter peer-select peer peer_name [ realm realm_name ] [ secondary-peer secondary_peer_name [ realm realm_name ] ] [ imsi-based { { prefix | suffix } imsi/prefix/suffix_start_value } [ to imsi/prefix/suffix_end_value ] ] [ msisdn-based { { prefix | suffix } msisdn-based/prefix/suffix_start_value } [ to msisdn-based/prefix/suffix_end_value ] ]
no diameter peer-select [ imsi-based { { prefix | suffix } imsi/prefix/suffix_start_value } [ to imsi/prefix/suffix_end_value ] ] | [ msisdn-based { { prefix | suffix } msisdn-based/prefix/suffix_start_value } [ to msisdn-based/prefix/suffix_end_value ] ]
no
Removes previously configured Diameter credit control peer selection setting.
peer peer_name
Specifies the primary host name. as an alphanumeric string of 1 through 63 characters that can contain punctuation characters.
imsi-based start-value imsi_start_value end-value imsi_end_value
note_smallImportant: This section applies only to 8.3 and earlier releases.
Specifies peer selection based on International Mobile Subscriber Identification (IMSI) range.
start-value imsi_start_value specifies the start of range in integer value of IMSI, and end-value imsi_end_value specifies the end of range in integer value of IMSI.
imsi-based { { prefix | suffix } imsi/prefix/suffix_start_value } [ to imsi/prefix/suffix_end_value ]
note_smallImportant: This section applies only to 9.0 and later releases for UMTS deployments.
Selects peer based on IMSI prefix or suffix or IMSI range.
prefix: Specifies the prefix range
suffix: Specifies the suffix range
imsi/prefix/suffix_start_value: Specifies the IMSI/prefix/suffix start value. prefix/suffix must be an IMSI prefix/suffix, and must be an integer from 1 through 15 characters.
imsi/prefix/suffix_end_value: Specifies the IMSI/prefix/suffix end value. prefix/suffix must be an IMSI prefix/suffix, and must be an integer from 1 through 15 characters that must be greater than the start value.
note_smallImportant: If prefix/suffix is used, the lengths of both start and end prefix/suffix must be equal. If the prefix or suffix keyword is not specified, it will be considered as suffix.
msisdn-based { { prefix | suffix } msisdn/prefix/suffix_start_value } [ to msisdn/prefix/suffix_end_value ]
Specifies peer selection based on MSISDN prefix or suffix or MSISDN range.
prefix: Specifies the prefix range
suffix: Specifies the suffix range
msisdn/prefix/suffix_start_value: Specifies the MSISDN/prefix/suffix start value. prefix/suffix must be an MSISDN prefix/suffix, and must be an integer from 1 through 15 characters.
msisdn/prefix/suffix_end_value: Specifies the MSISDN/prefix/suffix end value. prefix/suffix must be an MSISDN prefix/suffix, and must be an integer from 1 through 15 characters that must be greater than the start value.
realm realm_name
The realm_name must be an alphanumeric string of 1 through 127 characters, and can contain punctuation characters. The realm may typically be a company or service name.
secondary-peer secondary_peer_name
Specifies a name for the secondary host to be used for failover processing. When the route-table does not find an AVAILABLE route, the secondary host performs a failover processing if the diameter session failover command is set.
secondary_peer_name must be an alphanumeric string of 1 through 63 characters, and can contain punctuation characters.
Usage
Use this command to configure Diameter credit control host selection.
If the diameter peer-select command is not configured, and if multiple peers are configured in the endpoint, the available peers configured in the endpoint are automatically chosen in a load-balanced round-robin manner.
StarOS 9.0 and later releases support peer selection using prefix or suffix of IMSI or IMSI range. Subscribers are now assigned to a primary OCS instance based on the value of the IMSI prefix or suffix of a length of 1 to 15 digits. If the prefix or suffix keyword is not specified, it will be considered as suffix. Up to 64 peer selects can be configured. At a time either prefix or suffix mode can be used in one DCCA config. If prefix or suffix mode is used, the lengths of all prefix/suffix must be equal.
In 12.2 and later releases, Diameter peer selection can also be performed based on the configurable prefix or suffix of MSISDN or MSISDN range.
Each primary OCS may have a designated secondary OCS in case of failure of the primary. It will be the responsibility of the GGSN to use the appropriate secondary OCS in case of primary failure. The secondary OCS for each primary OCS will be one of the existing set of OCSs.
Example
The following command configures a Diameter credit control peer named test and the realm companyx:
diameter peer-select peer test realm companyx
The following command configures IMSI-based Diameter credit control peer selection in the IMSI range of 1234567890 to 1234567899:
diameter peer-select peer star imsi-based start-value 1234567890 end-value 1234567899
The following command configures IMSI-based DCCA peer selection with IMSI suffix of 100 through 200:
diameter peer-select peer test_peer realm test_realm secondary-peer test_sec_realm realm test_realm2 imsi-based suffix 100 to 200
diameter pending-timeout
This command configures the maximum time period to wait for response from a Diameter peer.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter pending-timeout duration
default diameter pending-timeout
default
Disables DCCA resending message at pending-timeout.
duration
Specifies the timeout duration (in seconds). The value must be an integer from 1 through 300.
after-expiry-try-secondary-host
This keyword is deprecated. This can now be managed using the retry-after-tx-expiry and go-offline-after-tx-expiry keywords in the failure-handling command.
Usage
Use this command to set the maximum time for Diameter credit control to receive a response from its peer.
DCCA refers to this as the Tx Timer. Typically, this should be configured to a value smaller than the response-timeout value of Diameter Endpoint Configuration Mode. That value is typically too large for DCCA's purposes.
If DCCA gets a “no available routes” error before pending-timeout expires, then DCCA tries to send to the secondary host (if one has been configured). If DCCA gets no response and pending-timeout expires, then DCCA either tries the secondary host or gives up. This can now be managed using the failure-handling command.
If routing has failed, i.e., the attempt to the primary host, as well as, the attempt to the secondary host (if that has been configured), then the processing configured by the failure-handling command is performed.
The routing (i.e., returning a good response, no response or an error response such as "no available routes") is controlled by Diameter Endpoint Configuration Mode. That uses a watchdog timer (called Tw Timer) to attempt a different route to a host. Multiple routes could be attempted. If there's no response before the endpoint's configured response-timeout expires, then "no available routes" is the routing result. The routing logic remembers the status of routes, so it can return "no available routes" immediately, without using any timers.
The default case will disable DCCA resending message at Tx (pending-timeout). So messages are retried only at Tw (device watchdog timeout) by diabase or at response-timeout by DCCA.
Example
The following command configures a Diameter Credit Control Pending Timeout setting of 20 seconds:
diameter pending-timeout 20
diameter result-code
This command enables sending a GTP Create-PDP-Context-Rsp message with cause code based on the DCCA result code.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter result-code { authorization-rejected | credit-limit-reached | end-user-service-denied | user-unknown } use-gtp-cause-code { authentication-failure | no-resource-available | system-failure }
default diameter result-code { authorization-rejected | credit-limit-reached | end-user-service-denied | user-unknown } use-gtp-cause-code
default
Configures this command with the default setting.
In 12.1 and earlier releases: no-resource-available
In 12.2 and later releases: system-failure
authorization-rejected
Result code received as DIAMETER_AUTHORIZATION_REJECTED(5003).
credit-limit-reached
Result code received as DIAMETER_CREDIT_LIMIT_REACHED(4012).
end-user-service-denied
Result code received as DIAMETER_END_USER_DENIED(4010).
user-unknown
Result code received as DIAMETER_USER_UNKNOWN(5030).
use-gtp-cause-code
Cause code to be sent in GTP response.
authentication-failure
Sends the GTP cause code GTP_USER_AUTHENTICATION_FAILED in GTP response.
no-resource-available
Sends the GTP cause code GTP_NO_RESOURCES_AVAILABLE in GTP response.
system-failure
Sends the GTP cause code GTP_SYSTEM_FAILURE in GTP response.
Usage
On receiving result-code as AUTHORIZATION-REJECTED, CREDIT_LIMIT_REACHED, END_USER_DENIED or USER_UNKNOWN from DCCA server, based on this CLI configuration, in GTP Create-PDP-Context Response message the cause code can either be sent as GTP_NO_RESOURCE_AVAILABLE or GTP_AUTHENTICATION_FAILED or GTP_SYSTEM_FAILURE.
Example
The following command sets the deny cause as user authentication failure when the CCA-Initial has the result code DIAMETER_AUTHORIZATION_REJECTED(5003):
diameter result-code authorization-rejected use-gtp-cause-code authentication-failure
diameter send-ccri
This command configures when to send an initial Credit Control Request (CCR-I) for the subscriber session.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter send-ccri { session-start | traffic-start }
default diameter send-ccri
default
Configures this command with the default setting.
Default: session-start
session-start
Sends CCR-I when the PDP context is being established (on receiving Create-PDP-Context-Request).
traffic-start
Delays sending CCR-I until the first data packet received from the subscriber.
Usage
Use this command to configure when to send CCR-Initial for the subscriber session.
Example
The following command configures to send CCR-I on traffic detection and not on context creation:
diameter send-ccri traffic-start
diameter service-context-id
This command configures the value to be sent in the Service-Context-Id AVP, which identifies the context in which DCCA is used.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter service-context-id service_context_id
default diameter service-context-id
default
Configures this command with the default setting. Currently, the default value is encoded based on the dictionary wherever applicable; when not applicable, it is not encoded.
service_context_id
Specifies the service context as an alphanumeric string of 1 through 63 characters that can contain punctuation characters.
Usage
If Service-Context-Id is applicable and configured using this command, it will be sent in the AVP Service-Context-Id in the Diameter CCR message.
Example
The following command specifies the value version@customer.com to be sent in the Service-Context-Id AVP in the Diameter CCR message:
diameter service-context-id version@customer.com
diameter session failover
This command enables/disables Diameter Credit Control Session Failover. When enabled, the secondary peer is used in the event the main peer is unreachable.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] diameter session failover
default
Configures this command with the default setting.
Default: Depends on the failure-handling configuration
no
If the primary server is not reachable, failover is not triggered and the session is torn down. No failover action is taken.
Usage
Use this command to enable/disable Diameter Credit Control Session Failover.
The failure-handling configuration comes into effect only if diameter session failover is present in the configuration. The failover can be overridden by the server in the response message, and it takes precedence.
Example
The following command enables Diameter Credit Control Session Failover:
diameter session failover
diameter update-dictionary-avps
This command enables dictionary control of the AVPs that need to be added based on the version of the specification with which the Online Charging System (OCS) is compliant. This command is applicable to all products that use the dcca-custom8 dictionary for Gy interface implementation.
Product
All
Privilege
Security Administrator, Administrator
Syntax
diameter update-dictionary-avps { 3gpp-rel8 | 3gpp-rel9 }
[ default | no ] diameter update-dictionary-avps
default | no
Configures this command with the default setting.
Default: Compliant with the oldest release (Rel. 7) and send only Rel. 7 AVPs
3gpp-rel8
Select the 3GPP Rel. 8 AVPs for encoding.
3gpp-rel9
Selects the 3GPP Rel. 9 AVPs for encoding.
Usage
note_smallImportant: This command is applicable ONLY to the dcca-custom8 dictionary. If, for any dictionary other than dcca-custom8, this command is configured with a value other than the default, configuration errors will be indicated in the output of the show configuration errors section active-charging command.
Use this command to encode the AVPs in the dictionary based on the release version of the specification to which the OCS is compliant with.
Example
The following command enables encoding of AVPs in the dictionary based on 3GPP Rel. 9:
diameter update-dictionary-avps 3gpp-rel9
end
Exits the current configuration mode and returns to the Exec mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
end
Usage
Use this command to return to the Exec mode.
exit
Exits the current mode and returns to the parent configuration mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
exit
Usage
Use this command to return to the parent configuration mode.
failure-handling
This command configures Diameter Credit Control Failure Handling (CCFH) behavior in the event of communication failure with the prepaid server.
Product
All
Privilege
Security Administrator, Administrator
Syntax
failure-handling { initial-request | terminate-request | update-request } { continue [ go-offline-after-tx-expiry | retry-after-tx-expiry ] | retry-and-terminate [ retry-after-tx-expiry ] | terminate }
default failure-handling [ initial-request | terminate-request | update-request ]
default failure-handling [ initial-request | terminate-request | update-request ]
Configures the default CCFH setting.
initial-request: The default setting is terminate.
update-request: The default setting is retry-and-terminate.
terminate-request: The default setting is retry-and-terminate.
initial-request
Specifies the message type as CCR-Initial.
terminate-request
Specifies the message type as CCR-Terminate.
update-request
Specifies the message type as CCR-Update.
continue
Specifies the CCFH setting as continue. The online session is converted into an offline session. The associated PDP Context is established (new sessions) or not released (ongoing sessions).
retry-and-terminate
Specifies the CCFH setting as retry-and-terminate. The user session will continue for the duration of one retry attempt with the prepaid server. If there is no response from both primary and secondary servers, the session is torn down.
terminate
Specifies the CCFH setting as terminate. All type of sessions (initial or update) are terminated in case of failure.
go-offline-after-tx-expiry
Starts offline charging after Tx expiry.
retry-after-tx-expiry
Retries after Tx expiry. Enables secondary-host, if up, to take over after Tx expiry.
Usage
Use this command to select the CCFH behavior. The specified behavior is used for sessions when no behavior is specified by the prepaid server. By default, the CCFH is taken care at response-timeout except for terminate setting.
If the Credit-Control-Failure-Handling AVP is received from the server, the received setting will be applied to all the message types.
The following table indicates the CCFH behavior for the combination of different CCFH settings, and the corresponding CLI commands.
Example
The following command sets the Credit Control Failure Handling behavior for initial request message type to retry-and-terminate:
failure-handling initial-request retry-and-terminate
mode
This command configures the Prepaid Credit Control mode to RADIUS or Diameter.
Product
All
Privilege
Security Administrator, Administrator
Syntax
mode { diameter | radius }
default mode
default
Configures the default prepaid credit control mode.
Default: diameter
diameter
Enables Diameter Credit Control Application (DCCA) for prepaid charging.
radius
Enables RADIUS Credit Control for prepaid charging.
Usage
Use this command to configure the prepaid charging application mode to Diameter or RADIUS credit control.
Example
The following command specifies to use RADIUS prepaid credit control application:
mode radius
pending-traffic-treatment
This command controls the pass/drop treatment of traffic while waiting for definitive credit information from the server.
Product
All
Privilege
Security Administrator, Administrator
Syntax
pending-traffic-treatment { { { forced-reauth | trigger | validity-expired } drop | pass } | { { noquota | quota-exhausted } buffer | drop | limited-pass volume | pass } }
default pending-traffic-treatment { forced-reauth | noquota | quota-exhausted | trigger | validity-expired }
default
Configures this command with the default setting.
Default: drop
forced-reauth
Sets the Diameter credit control pending traffic treatment to forced reauthorization.
trigger
Sets the Diameter credit control pending traffic treatment to trigger.
validity-expired
Sets the Diameter credit control pending traffic treatment to validity expired.
noquota
Sets the Diameter credit control pending traffic treatment to no quota.
quota-exhausted
Sets the Diameter credit control pending traffic treatment to quota exhausted.
buffer
Specifies to tentatively count/time traffic, and then buffer traffic pending arrival of quota. Buffered traffic will be forwarded and fully charged against the quota when the quota is eventually obtained and the traffic is passed.
drop
Drops any traffic when there is no quota present.
limited-pass volume
Enables limited access for subscribers when the OCS is unreachable.
volume specifies the Default Quota size (in bytes) and must be an integer from 1 through 4294967295.
This feature allows the subscriber to use the network when the OCS response is slow. This configuration enables to set a Default Quota size from which the subscriber can consume quota until response from the OCS arrives. The traffic consumed by the subscriber from the Default Quota at the beginning of the session is reported and counted against the quota assigned from the OCS.
Default Quota is not used for subsequent credit requests.
If the Default Quota is NOT exhausted before the OCS responds with quota, traffic is allowed to pass. Initial Default Quota usage is counted against initial quota allocated. If quota allocated is less than the actual usage, the actual usage and request additional quota are reported. If no additional quota is available, the traffic is denied.
If the Default Quota is NOT exhausted before the OCS responds with denial of quota, traffic is blocked after the OCS response. The gateway will report usage on Default Quota even in for CCR-U (FINAL) or CCR-T until the OCS responds.
If the Default Quota is exhausted before the OCS responds, the session is dropped.
The default pending-traffic-treatment for noquota is drop. The default pending-traffic-treatment noquota command removes any Default Quota limit configured.
pass
Passes all traffic more or less regardless of quota state.
Usage
Use this command to set the Diameter credit control pending traffic treatment while waiting for definitive credit information from the server.
This CLI command is different than the failure-handling command, which specifies behavior in the case of an actual timeout or error, as opposed to the behavior while waiting. See also the buffering-limit command in the Active Charging Service Configuration Mode.
Example
The following command sets the Diameter credit control pending traffic treatment to drop any traffic when there is no quota present:
pending-traffic-treatment noquota drop
quota
This command sets various time-based quotas in the prepaid credit control service.
Product
All
Privilege
Security Administrator, Administrator
Syntax
quota holding_time | validity-time validity_time }
{ default | no } quota { holding-time | validity-time }
holding-time holding_time
Specifies the Quota Holding Time (QHT) in seconds. The value must be an integer from 1 through 4000000000.
 
validity-time validity_time
Specifies the validity lifetime of the quota, in seconds. The value must be an integer from 1 through 65535.
Usage
Use this command to set the prepaid credit control quotas.
Example
The following command sets the prepaid credit control request holding time to 30000 seconds:
quota holding-time 30000
quota request-trigger
This command configures the action on the packet that triggers the credit control application to request quota.
Product
All
Privilege
Security Administrator, Administrator
Syntax
quota request-trigger { exclude-packet-causing-trigger | include-packet-causing-trigger }
{ default | no } quota request-trigger
default quota request-trigger
Configures this command with the default setting. Default: include-packet-causing-trigger
no
Same as the default quota request-trigger command.
note_smallImportant: In 10.0 and later releases, this keyword is deprecated.
exclude-packet-causing-trigger
Excludes the packet causing threshold limit violation trigger.
include-packet-causing-trigger
Includes the packet causing the threshold limit violation trigger.
Usage
Use this command to configure action on the packet that triggers the credit control application to request quota, whether the packet should be excluded/included in the utilization information within the quota request.
Example
The following command sets the system to exclude the packets causing threshold limit triggers from accounting of prepaid credit of a subscriber:
quota request-trigger exclude-packet-causing-trigger
quota time-threshold
This command configures the time threshold limit for subscriber quota in the prepaid credit control service.
Product
All
Privilege
Security Administrator, Administrator
Syntax
quota time-threshold { abs_time_value | percent percent_value }
{ default | no } quota time-threshold
default
Configures this command with the default setting.
Default: Disabled
no
Disables time threshold for prepaid credit control quota.
abs_time_value
Specifies the absolute threshold time (in seconds) for configured time quota in prepaid credit control charging. abs_time_value must be an integer from 1 through 86400. To disable this assign 0. Default: 0 (Disabled)
percent_value
Specifies the time threshold value as a percentage of the configured time quota in DCCA. percent_value must be an integer from 1 through 100.
Usage
Use this command to set the time threshold for prepaid credit control quotas.
Example
The following command sets the prepaid credit control time threshold to 400 seconds:
quota time-threshold 400
quota units-threshold
This command sets the unit threshold limit for subscriber quota in the prepaid credit control service.
Product
All
Privilege
Security Administrator, Administrator
Syntax
quota unit-threshold { abs_unit_value | percent percent_value }
{ default | no } quota units-threshold
default
Configures this command with the default setting.
Default: Disabled
no
Disables unit threshold for DCCA quota.
abs_unit_value
Specifies the absolute threshold value (in units) for the configured units quota in prepaid credit control application. abs_unit_value must be an integer from 1 through 4000000000. To disable this assign 0. Default: 0 (Disabled)
percent_value
Specifies the time threshold value as a percentage of the configured units quota in DCCA. percent_value must be an integer from 1 through 100.
Usage
Use this command to set the units threshold for prepaid credit control quotas.
Example
The following command sets the prepaid credit control time threshold to 160400 units:
quota units-threshold 160400
quota volume-threshold
This command sets the volume threshold limit for subscriber quota in the prepaid credit control service.
Product
All
Privilege
Security Administrator, Administrator
Syntax
quota volume-threshold { abs_vol_value | percent percent_value }
{ default | no } quota volume-threshold
default
Configures this command with the default setting.
Default: Disabled
no
Disables volume threshold for prepaid credit control quota.
abs_vol_value
Specifies the absolute threshold volume (in bytes) to the configured volume quota in prepaid credit control. abs_vol_value must be an integer from 1 through 4000000000. To disable this assign 0. Default: 0 (Disabled)
percent percent_value
Specifies the volume threshold value as a percentage of the configured volume quota in prepaid credit control. percent_value must be an integer from 1 through 100.
Usage
Use this command to set the volume threshold for prepaid credit control quotas.
Example
The following command sets the prepaid credit control volume threshold to 160400 bytes:
quota volume-threshold 160400
radius usage-reporting-algorithm
This command configures the usage reporting algorithm for RADIUS prepaid using the Diameter Credit-Control Application (DCCA).
Product
All
Privilege
Security Administrator, Administrator
Syntax
radius usage-reporting-algorithm { cumulative | relative }
default radius usage-reporting-algorithm
default
Configures this command with the default setting.
Default: cumulative
cumulative
Reports the total accumulated usage of quota in every accounting interim.
relative
Reports the quota usage per accounting interim (since the previous usage report).
Usage
Use this command to configure the usage reporting algorithm for RADIUS prepaid using DCCA.
Example
The following command configures the usage reporting algorithm for RADIUS prepaid using DCCA to relative:
radius usage-reporting-algorithm relative
redirect-indicator-received
This command configures the action on buffered packets when a redirect-indicator is received from the RADIUS server.
Product
All
Privilege
Security Administrator, Administrator
Syntax
redirect-indicator-received { discard-buffered-packet | reprocess-buffered-packet }
{ default | no } redirect-indicator-received
default
Configures this command with the default setting. Default: discard-buffered-packet
no
Disables the redirect-indicator-received configuration.
discard-buffered-packet
Discards the buffered packet.
reprocess-buffered-packet
Redirects the buffered packet on receiving a redirect-indicator from the RADIUS server.
Usage
Use this command to configure the action taken on buffered packet when redirect-indicator is received.
Diameter can return a redirect URL but not a redirect indicator, however RADIUS can return a redirect indicator. In this situation, any subsequent subscriber traffic would match ruledefs configured with cca redirect-indicator, and charging actions that have flow action redirect-url should be configured. However, some handsets do not retransmit, so there will be no subsequent packets. On configuring reprocess-buffered-packet, the ruledefs are reexamined to find a new charging action, which may have flow action redirect-url configured.
Example
The following command configures the action taken on buffered packet when redirect-indicator is received to reprocess-buffered-packet:
redirect-indicator-received reprocess-buffered-packet
servers-unreachable
This command configures whether to continue or terminate calls when Diameter server(s) or the OCS become unreachable.
Product
All
Privilege
Security Administrator, Administrator
Syntax
In 12.1 and earlier releases:
servers-unreachable { initial-request { continue | terminate [ after-timer-expiry timeout_period ] } | update-request { continue | terminate [ after-quota-expiry | after-timer-expiry timeout_period ] } }
no servers-unreachable { initial-request | update-request }
In 12.2 and later releases:
servers-unreachable { behavior-triggers { initial-request | update-request } transport-failure [ response-timeout | tx-expiry ] | initial-request { continue [ { [ after-interim-timetimeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | terminate [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count | after-timer-expiry timeout_period ] } | update-request { continue [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | terminate [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | after-quota-expiry | after-timer-expiry timeout_period ] } }
no servers-unreachable { initial-request | update-request }
default servers-unreachable behavior-triggers { initial-request | update-request }
no
Deletes the current servers-unreachable configuration.
behavior-triggers { initial-request | update-request } transport-failure [ response-timeout | tx-expiry ]
This keyword is used to determine when to apply server-unreachable action. This supports three configurable options to apply server-unreachable action either at transport failure, Tx expiry or at response timeout. Out of these three options, the transport failure is the default option.
initial-request: Specifies the behavior when Diameter server(s)/OCS become unreachable during initial session establishment.
update-request: Specifies the behavior when Diameter server(s)/OCS become unreachable during mid-session.
transport-failure [ response-timeout | tx-expiry ]: Specifies to trigger the behavior either at transport failure, response timeout or at Tx expiry.
initial-request { continue | terminate [ after-timer-expiry timeout_period ] }
note_smallImportant: This section applies only to 12.1 and earlier releases.
Specifies behavior when Diameter server(s)/OCS become unreachable during initial session establishment.
continue: Specifies to continue call if Diameter server(s) becomes unreachable.
terminate [ after-timer-expiry timeout_period ]: Specifies to terminate call if Diameter server(s) becomes unreachable.
after-timer-expiry timeout_period: Specifies to terminate call after timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
initial-request { continue [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | terminate [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | after-timer-expiry timeout_period }
note_smallImportant: This section applies only to 12.2 and later releases.
Specifies behavior when Diameter server(s)/OCS become unreachable during initial session establishment.
continue: Specifies to continue call if Diameter server(s) becomes unreachable.
terminate: Specifies to terminate call if Diameter server(s) becomes unreachable.
after-interim-time timeout_period: Specifies to continue or terminate call after the interim timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
after-interim-volume quota_value: Specifies to continue or terminate call on exhaustion of the assigned quota.
quota_value specifies the volume-based quota value, in bytes, and must be an integer from 1 through 4294967295.
The after-interim-volume and after-interim-time can be configured in one of the following ways:
after-interim-volume quota_value server-retries retry_count
after-interim-time timeout_period server-retries retry_count
after-interim-volume quota_value after-interim-time timeout_period server-retries retry_count
after-timer-expiry timeout_period: Specifies to terminate call after timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
server-retries retry_count: Specifies the number of retries that should happen to OCS before allowing the session to terminate/offline.
retry_count specifies the retries to OCS, and must be an integer from 0 through 65535. If the value 0 is defined for this keyword, the retry to OCS will not happen instead the configured action will be immediately applied.
update-request { continue | terminate [ after-quota-expiry | after-timer-expiry timeout_period ] }
note_smallImportant: This section applies only to 12.1 and earlier releases.
Specifies behavior when Diameter server(s)/OCS become unreachable during mid session.
continue: Specifies to continue call if Diameter server(s) becomes unreachable.
terminate [ after-quota-expiry | after-timer-expiry timeout_period ]: Specifies to terminate call if Diameter server(s) becomes unreachable.
after-quota-expiry: Specifies to terminate call on exhaustion of all available quota.
after-timer-expiry timeout_period: Specifies to terminate call after timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
update-request { continue [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | terminate [ { [ after-interim-time timeout_period ] [ after-interim-volume quota_value ] } server-retries retry_count ] | after-quota-expiry | after-timer-expiry timeout_period ] }
note_smallImportant: This section applies only to 12.2 and later releases.
Specifies behavior when Diameter server(s)/OCS become unreachable during mid session.
continue: Specifies to continue call if Diameter server(s) becomes unreachable.
terminate: Specifies to terminate call if Diameter server(s) becomes unreachable.
after-interim-time timeout_period: Specifies to continue or terminate call after the interim timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
after-interim-volume quota_value: Specifies to continue or terminate call on exhaustion of the assigned quota.
quota_value specifies the volume-based quota value, in bytes, and must be an integer from 1 through 4294967295.
The after-interim-volume and after-interim-time can be configured in one of the following ways:
after-interim-volume quota_value server-retries retry_count
after-interim-time timeout_period server-retries retry_count
after-interim-volume quota_value after-interim-time timeout_period server-retries retry_count
after-quota-expiry: Specifies to terminate call on exhaustion of all available quota.
after-timer-expiry timeout_period: Specifies to terminate call after timeout period expires.
timeout_period specifies the timeout period, in seconds, and must be an integer from 1 through 4294967295.
server-retries retry_count: Specifies the number of retries that should happen to OCS before allowing the session to terminate/offline.
retry_count specifies the retries to OCS, and must be an integer from 0 through 65535. If the value 0 is defined for this keyword, the retry to OCS will not happen instead the configured action will be immediately applied.
Usage
Use this command to configure whether to continue/terminate calls when Diameter server(s)/OCS are unreachable. This command can be used to verify the functionality of the configurable action if the OCS becomes unreachable.
In 12.1 and earlier releases, the OCS is considered down/unreachable when all transport/TCP connections are down for that OCS.
In 12.2 and later releases, the OCS is declared unreachable when all transport connections are down OR message timeouts happen (for example, a Tx expiry or response timeout, for all available OCS servers) owing to slow response from the OCS (may be due to network congestion or other network related issues).
The following set of actions are performed if the servers become unreachable:
This command works on the same lines as the failure-handling command, which is very generic for each of the xxx-request and applies for Credit-Control-Failure-Handling (CCFH) during:
1.
2.
3.
This CLI command is specifically for TCP connection error. The administrator can configure both of the following commands:
failure-handling initial-request continue
servers-unreachable initial-request terminate after-timer-expiry 30
For conditions 1 and 2 described above, the failure-handling command will be applied, whereas for condition 3 both failure-handling and/or servers-unreachable commands can be used. This way, the operator has the flexibility to configure CCFH independent of OCS-unreachable feature, that is have two different failure handlings for same request types (as illustrated in the example above.)
note_smallImportant: Please note that the flexibility to configure CCFH independent of OCS-unreachable feature is applicable only to 12.1 and earlier releases. In 12.2 and later releases, if configured, the servers-unreachable takes precedence over the failure-handling command.
If server returns the CC-Failure-Handling AVP, it would apply for conditions 1 and 2 described above. It would also apply for condition 3 if the servers-unreachable command is not configured. But, if configured it would take the highest precedence for all Diabase errors scenarios.
This command can also be used to control the triggering of behavior based on either due to transport failure, response message timeouts or Tx expiry when OCS becomes unreachable. The transport failure could be due to no TCP connection and the message timeout could be due to network congestion or any other network related issues.
The following are the possible and permissible configurations with respect to behavior triggering:
Of these configurations, the first one is considered to be the default configuration and it will take care of backward compatibility.
Example
The following command configures to terminate initial request calls if Diameter servers/OCS becomes unreachable after a timeout period of 1111 seconds:
servers-unreachable initial-request terminate after-timer-expiry 1111
timestamp-rounding
This command configures how to convert exact time into the units that are used in quotas.
Product
ACS
Privilege
Security Administrator, Administrator
Syntax
timestamp-rounding { ceiling | floor | roundoff }
default timestamp-rounding
default
Configures the default timestamp-rounding setting.
Default: roundoff
timestamp-rounding ceiling
Round off to the smallest integer greater than the fraction.
If the fractional part of the seconds is greater than 0, add 1 to the number of seconds and discard the fraction.
timestamp-rounding floor
Discard the fractional part of the second.
timestamp-rounding roundoff
Set the fractional part of the seconds to the nearest integer value. If the fractional value is greater than or equal to 0.5, add 1 to the number of seconds and discard the fractional part of second.
Usage
Use this command to configure how to convert exact time into the units that are used in quotas for CCA charging.
The specified rounding will be performed before system attempts any calculation. For example using round-off, if the start time is 1.4, and the end time is 1.6, then the calculated duration will be 1 (i.e., 2 – 1 = 1).
Example
The following command sets the CCA timestamp to nearest integer value second (for example, 34:12.23 to 34:12.00):
timestamp-rounding roundoff
trigger type
This command enables/disables triggering a credit reauthorization when the named values in the subscriber session changes.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no ] trigger type { cellid | lac | | mcc | mnc | qos | rat | serving-node | sgsn } +
default trigger type
default
Configures this command with the default setting.
Default: No triggers.
no
Removes the previously configured trigger type.
cellid
Sets the trigger based on change in cell identity or Service Area Code (SAC).
lac
Sets the trigger based on change in Location Area Code.
mcc
Sets the trigger based on change in Mobile Country Code (MCC).
mnc
Sets the trigger based on change in Mobile Network Code (MNC).
qos
Sets the trigger based on change in the Quality of Service (QoS).
rat
Sets the trigger based on change in the Radio Access Technology (RAT).
serving-node
Sets the trigger based on change in serving node. The serving node change causes the credit control client to ask for a re-authorization of the associated quota.
Typically used as an extension to sgsn trigger in P-GW, however, may also be used alone.
sgsn
Sets the trigger based on change in the IP address of SGSN.
+
Indicates that more than one of the previous keywords can be entered within a single command.
Usage
Use this command to set the credit control reauthorization trigger.
Example
The following command selects a credit control trigger as lac:
trigger type lac
usage-reporting
This command configures the ACS Credit Control usage reporting type.
Product
All
Privilege
Security Administrator, Administrator
Syntax
usage-reporting quotas-to-report based-on-grant { report-only-granted-volume }
default usage-reporting quotas-to-report
default
Configures this command with the default setting.
Default: Disabled
report-only-granted-volume
Suppresses the input and output octets. If the Granted-Service-Unit (GSU) AVP comes with CC-Total-Octets, then the device will send total, input and output octets in Used-Service-Unit (USU) AVP. If it comes with Total-Octets, the device will send only Total-Octets in USU.
Usage
Use this command to configure reporting usage only for granted quota. On issuing this command, the Used-Service-Unit AVP will report quotas based on grant i.e, only the quotas present in the Granted-Service-Unit AVP.
With this command only the units for which the quota was granted by the DCCA server will be reported irrespective of the reporting reason.
Example
The following command configures to report usage based only on granted quota:
usage-reporting quotas-to-report based-on-grant
 
 

Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883